home *** CD-ROM | disk | FTP | other *** search
/ Workbench Design / WB Collection.iso / workbench werkzeuge / programmmanager / wangipad / wangipad.guide (.txt) < prev    next >
Amigaguide Document  |  1996-04-07  |  37KB  |  719 lines

  1. @database NewWP
  2. @$VER: WangiPad_Documentation 1.16
  3. @author "Lee Kindness"
  4. @node Main "Amigaguide Documentation for WangiPad v1.16"
  5. @{fg highlight}             __@{fg text}
  6. @{fg highlight}  ___________\ \____________________________@{fg text}
  7. @{fg highlight}  \_____  ____\ \____________________   __  \ @{fg text}    WangiPad 1.16
  8. @{fg highlight}       / /     \ \                  /  /_/  /@{fg text}     @{b}THE@{ub} tool launcher
  9. @{fg highlight}      / /   __  \ \                /  _____/@{fg text}      for your Workbench 2.04
  10. @{fg highlight}     / /   /  \  \ \          __  /  /@{fg text}            Amiga.
  11. @{fg highlight}    / /   / /\ \  \ \         \ \/  /@{fg text}
  12. @{fg highlight}   / /___/ /  \ \__\ \         \   /@{fg text}
  13. @{fg highlight}   \______/    \_____/angi!     \_/ad@{fg text}
  14.         @{" Introduction     " link INTRO                } : Read this NOW.
  15.         @{" Features         " link FEATURES             } : Why use WP?
  16.         @{" Usage            " link USAGE                } : How to use it.
  17.         @{" Version History  " link VERH                 } : Evolution.
  18.         @{" To Do            " link TODO                 } : My plans.
  19.         @{" Thanks/Greets    " link TABILLY              } : Ta Billy :)
  20.         @{" Contact/Register " link CONTACT              } : Authors address.
  21.         @{" Other Programs   " link OtherProgs.doc/main  } : Some programs you should try.
  22.         @{" Distribution     " link Distribution.doc/main} : Important!
  23. @{fg highlight}WangiPad the "clean and fresh" tool launcher. Copyright 94-95 Lee Kindness.@{fg text}
  24. @endnode
  25. # *****************************************************************************
  26. @node INTRO "Introduction. It all began when..."
  27.     WangiPad... Eh? Yes it is a strange name but it is a simply a program
  28. that launches programs. You will know what it is like if you have a harddisk,
  29. click-click, click-click, click-click... through all your drawers to run just
  30. one program. WangiPad is the solution to this problem. It creates a menu on 
  31. your Workbench screen.
  32.     Chances are that you will probably be using a @{"similar utility" link FEATURES 37} 
  33. already, so why change to WangiPad? The main reason in my opinion is the 
  34. format of the menu it creates, most similar utilities create rows of buttons 
  35. or just add items to the Workbench Tools menu. However WangiPad creates a 
  36. scrolling list of items (called a pad). This method saves space and is more 
  37. elegant than other solutions. For more advantages see @{"Features" link FEATURES}.
  38.     Oh, by the way, Wangi actually means "@{i}Clean and Fresh@{ui}" (Malaysian?), 
  39. or so I have been told.
  40. @endnode
  41. # *****************************************************************************
  42. @node FEATURES "Features of WangiPad"
  43. Here are the main features of WangiPad over similar utilities (which are 
  44. listed later):
  45.     1.  Has a unique @{"list approach" link UPREFS} (using a gadtools listview).
  46.     2.  Because of 1. it saves space on your Workbench screen, when
  47.         compared to the button docks of ToolManager, ButtonMenu and
  48.         AmiDock.
  49.     3.  The list approach is less awkward than using the Workbench
  50.         Tools menu. However WangiPad can also add items to the Workbench
  51.         @{"Tools menu" link G_TOOL}.
  52.     4.  WangiPad supports @{"multiple argument substitution" link ARGSUB}. For example,
  53.         you use shift-select the pick a group of files, hold down shift
  54.         and drag the files over an item on WangiPad's list. The 
  55.         corresponding item is then run with the passed files as arguments.
  56.     5.  Items on the list can be of the following @{"types" link G_TYPE}: Workbench, Shell
  57.         ARexx or Comment.
  58.     6.  Each item can have a @{"hotkey" link G_HOTK} for all you keyboard junkies.
  59.     7.  It is @{"easy to configure" link UPREFS}... just drag the icon of the command you
  60.         wish to add to the list to the preference window and its added.
  61.     8.  Has an easy to use @{"preference editor" link UPREFS}.
  62.     9.  It is being constantly improved and updated, see @{"ToDo" link TODO} and 
  63.         @{"Version History" link VERH}.
  64.     10. Eh, it has a cool name :)
  65. @{u}Similar Utilities@{uu}
  66.     If WangiPad does not appeal to you, or if you want to compare then
  67. here is where you can find similar utilities on Aminet:
  68. ToolManager21bin.lha util/boot  490K+ToolManager 2.1 (Binaries and Documentatio
  69. ToolManager21gfx.lha util/boot  175K+ToolManager 2.1 (Anims, Brushes and Icons)
  70. ButtonMenu_122.lha   util/misc   58K+Easy creation of customizable menus (OS2.0
  71. AmiDock.lha          util/boot   56K+Amiga version of NeXT's Dock facility. V1.
  72. ToolsDeamon.lha      util/wb     29K+Run programs from tools menu, V1.0, bin. V
  73. Of course this is not a list of all similar utilities, but a summary of the
  74. better ones (IMHO).
  75. @endnode
  76. # *****************************************************************************
  77. @node USAGE "Using WangiPad"
  78.     @{" Installation     " link INSTALL} : The first steps...
  79.     @{" Using WangiPrefs " link UPREFS } : The NeXT step...
  80.     @{" Using WangiPad   " link UPAD   } : The final step...
  81. @endnode
  82. # *****************************************************************************
  83. @node INSTALL "Installing WangiPad"
  84.     To install WangiPad, simply double-click on the supplied installer
  85. script (Install_WangiPad). This script requires the Commodore installer.
  86.     It is assumed that you already have Reqtools installed on your system.
  87. It is required only for minor functions and therefore is not crucial.
  88. @endnode
  89. # *****************************************************************************
  90. @node UPREFS "Using WangiPrefs"
  91.     WangiPrefs is used to configure WangiPad to your needs. The 
  92. @{"installer script" link INSTALL}, by default, copies WangiPrefs to SYS:Prefs/. You can use 
  93. WangiPrefs by either double-clicking on its icon from Workbench or selecting 
  94. the "Preferences..." item on the menu attached to a WangiPad pad. If launch via
  95. the "Preferences..." @{"menuitem" link N_PREF} then the preferences of @{"that pad" link P_ARGS} will be 
  96. altered, even if it does not use the default S:Wangi.prefs preference file.
  97.     The main window of WangiPrefs contains the following buttons and
  98. gadgets, select the appropriate one for more information:
  99.     @{" List Items " link U_LIST} : List containing all items on the pad.
  100.     @{" Settings   " link U_SETT} : Misc. global settings.
  101.     @{" Save       " link U_SAVE} : Save the preferences.
  102.     @{" Cancel     " link U_QUIT} : Cancel, without saving.
  103.     @{" Top        " link U_TOPX} : Move item to top of list.
  104.     @{" Up         " link U_UPXX} : Move item up list.
  105.     @{" Down       " link U_DOWN} : Move item down list.
  106.     @{" Bottom     " link U_BOTT} : Move item to bottom of list.
  107.     @{" Sort       " link U_SORT} : Sort the list.
  108.     @{" New        " link U_NEWX} : Add a new item to the list.
  109.     @{" Remove     " link U_REMO} : Remove an item from the list.
  110.     @{" Copy       " link U_COPY} : Clone an item on the list.
  111.     The following menus also exist:
  112.     @{"Project/Open...        " link U_OPEN} : Open another preference file.
  113.     @{"Project/Append...      " link U_APND} : Append another preference file.
  114.     @{"Project/Save As...     " link U_SVAS} : Save preferences elsewhere.
  115.     @{"Project/About...       " link U_INFO} : Some information on WangiPad.
  116.     @{"Project/Quit           " link U_QUIT} : Quit without saving.
  117.     @{"Edit/Reset To Defaults " link U_DEFS} : Reset preferences to default settings.
  118.     @{"Edit/Restore           " link U_REST} : Reset preferences to previous values.
  119.     To make configuration easier you can simply drag the icon of the 
  120. program that you wish to add to the menu into the window. This will create
  121. an appropriate item and bring up the @{"Edit Pad Item" link EDITPAD} window.
  122. @endnode
  123. # *****************************************************************************
  124. @node U_LIST "List Items Listview"
  125.     This list contains all items that will be on the created pad. To
  126. edit an item, simply double-click on it and the @{"Edit Pad Item" link EDITPAD} window 
  127. will pop up.
  128. @endnode
  129. # *****************************************************************************
  130. @node U_SETT "Settings"
  131.     This list contains items which allow you to edit some global settings
  132. for the pad. Double click on an item to modify that setting. Settings:
  133.     @{" Font         " link S_FONT} : The font used on the pad.
  134.     @{" Window Title " link S_WTIT} : Text in the pad titlebar.
  135.     @{" Screen Title " link S_STIT} : Text on the screen titlebar.
  136.     @{" Window       " link S_WIND} : Settings for the pad window.
  137. @endnode
  138. # *****************************************************************************
  139. @node U_SAVE "Save"
  140.     The Save button will save the current preferences and exit the program.
  141. @endnode
  142. # *****************************************************************************
  143. @node U_QUIT "Cancel/Quit"
  144.     The cancel button and the Quit menuitem will exit the program. The
  145. settings will not be saved and the pad will be as it was before you ran
  146. WangiPrefs.
  147. @endnode
  148. # *****************************************************************************
  149. @node U_TOPX "Top"
  150.     This button will cause the currently selected item in the @{"List Items" link U_LIST}
  151. list to move to the top.
  152. @endnode
  153. # *****************************************************************************
  154. @node U_UPXX "Up"
  155.     This button will move the currently selected item in the @{"List Items" link U_LIST}
  156. up one position.
  157. @endnode
  158. # *****************************************************************************
  159. @node U_DOWN "Down"
  160.     This button will move the currently selected item in the @{"List Items" link U_LIST}
  161. down one position.
  162. @endnode
  163. # *****************************************************************************
  164. @node U_BOTT "Bottom"
  165.     This button will move the currently selected item in the @{"List Items" link U_LIST}
  166. list to the bottom of the list.
  167. @endnode
  168. # *****************************************************************************
  169. @node U_SORT "Sort"
  170.     This button will cause the @{"List Items" link U_LIST} to be sorted. It is
  171. sorted into ascending alphabetical order.
  172. @endnode
  173. # *****************************************************************************
  174. @node U_NEWX "New"
  175.     This button will add a new item to the top of the @{"List Items" link U_LIST} list. 
  176. The @{"edit pad" link EDITPAD} window will pop up allowing you to edit the new item. If
  177. you select cancel on the edit pad window then this item will be removed.
  178. @endnode
  179. # *****************************************************************************
  180. @node U_REMO "Remove"
  181.     This button will delete the currently selected item in the 
  182. @{"List Items" link U_LIST} list.
  183. @endnode
  184. # *****************************************************************************
  185. @node U_COPY "Copy"
  186.     This button will clone the currently selected item in the@{"List Items" link U_LIST}
  187. list.
  188. @endnode
  189. # *****************************************************************************
  190. @node U_OPEN "Project/Open..."
  191.     Open a new preference file, loosing the current one (all changes are
  192. lost). 
  193. NOTE:
  194.     Even thought you have opened a new file, if you now press the @{"Save" link U_SAVE}
  195. button then the preferences will be saved to the original file (defaults
  196. to S:Wangi.prefs or the the appropriate file if the @{"Preferences" link N_PREFS} menuitem
  197. was selected from WangiPad. To save the file in another location, use the
  198. @{"Save As" link U_SVAS} menuitem.
  199. @endnode
  200. # *****************************************************************************
  201. @node U_APND "Project/Append..."
  202.     Add the items stored in another file to the end of the current list.
  203. The other settings in this file are ignored. This is useful if you wish to join
  204. two preference file together into one.
  205. @endnode
  206. # *****************************************************************************
  207. @node U_SVAS "Project/Save As..."
  208.     Save the preference file in a user-defined location.
  209. @endnode
  210. # *****************************************************************************
  211. @node U_INFO "Project/About..."
  212.     Display some information. Shows the current version of WangiPad and
  213. also to whom it is registered.
  214. @endnode
  215. # *****************************************************************************
  216. @node U_DEFS "Edit/Reset To Defaults"
  217.     Sets the miscellaneous @{"Settings" link U_SETT} to their default values and clears
  218. the @{"List Items" link U_LIST} list. 
  219. @endnode
  220. # *****************************************************************************
  221. @node U_REST "Edit/Restore"
  222.     Resets the preferences to their values before WangiPad was run.
  223. @endnode
  224. # *****************************************************************************
  225. @node EDITPAD "Edit Pad Item Window"
  226.     This window lets you fine tune the preferences of each single item. It
  227. contains the following gadgets:
  228.     @{" Type          " link G_TYPE} : Type of item cycle gadget.
  229.     @{" Item Text     " link G_TEXT} : Text in list string gadget.
  230.     @{" Directory     " link G_CDIR} : Directory string gadget.
  231.     @{" Command       " link G_CMDX} : Command string gadget.
  232.     @{" Priority      " link G_PRIO} : Priority slider gadget.
  233.     @{" Stack         " link G_STCK} : Stack integer gadget.
  234.     @{" Input/Output  " link G_INOU} : I/O string gadget.
  235.     @{" ARexx Command " link G_REXC} : Rexx command string gadget.
  236.     @{" ARexx Port    " link G_REXP} : Rexx port string gadget.
  237.     @{" Hot Key       " link G_HOTK} : Hotkey string gadget.
  238.     @{" Tools Menu    " link G_TOOL} : Tools menu checkmark gadget.
  239.     @{" Edit Command  " link G_ECMD} : Edit command checkmark gadget.
  240.     @{" Ok            " link G_OKBU} : Ok button.
  241.     @{" Cancel        " link G_CANC} : Cancel button.
  242. If any of the gadgets are shaded, and therefore unselectable in means that 
  243. this option is not available for the selected @{"Type" link G_TYPE}.
  244. @endnode
  245. # *****************************************************************************
  246. @node G_TYPE "Type"
  247.     This cycle gadget lets you specify what type this item is. It can be
  248. one of the following:
  249. @{b}Shell@{ub}: The command is launched as if it were typed in at the command line.
  250. @{b}Workbench@{ub}: The command is launched as if it were double-clicked from 
  251. Workbench. See @{"Argument Substitution" link ARGSUB 26} and @{"Bugs" link BASTARDS}.
  252. @{b}ARexx@{ub}: This item initiates an ARexx command.
  253. @{b}Comment@{ub}: This is only a comment in the list, if selected in will do nothing.
  254. @endnode
  255. # *****************************************************************************
  256. @node G_TEXT "Item Text"
  257.     This string gadget specifies the text that will appear in the list.
  258. @endnode
  259. # *****************************************************************************
  260. @node G_CDIR "Directory"
  261.     This is the directory in which the @{"Command" link G_CMDX} is located. It can be set
  262. using a file requester if use press the "^" gadget.
  263. @endnode
  264. # *****************************************************************************
  265. @node G_CMDX "Command"
  266.     This is the command to be launched. It can be set using a file 
  267. requester if use press the "^" gadget. 
  268.     This command supports @{"argument substitution" link ARGSUB}
  269. @endnode
  270. # *****************************************************************************
  271. @node G_PRIO "Priority"
  272.     This lets you specify the priority of the launched @{"Command" link G_CMDX}.
  273. @endnode
  274. # *****************************************************************************
  275. @node G_STCK "Stack"
  276.     This lets you set the stack size of the launched @{"Command" link G_CMDX}.
  277. @endnode
  278. # *****************************************************************************
  279. @node G_INOU "Input/Output"
  280.     Lets you specify the input/output file handles for the @{"Command" link G_CMDX}.
  281. If empty then "NIL:" is assumed (i.e. all output is lost). If you want all input
  282. and output to a console window then use:
  283.     CON:X/Y/WIDTH/HEIGHT/TITLE/AUTO/WAIT/CLOSE
  284.     CON:////MyComamnd/AUTO/WAIT
  285.     CON:0/0/200/100//AUTO/WAIT/CLOSE
  286. (for further information see the documentation for KingCon (on Aminet: 
  287. util/shell/KingCON_1.3.lha (or similar)))
  288. @endnode
  289. # *****************************************************************************
  290. @node G_REXC "ARexx Command"
  291.     This lets you specify the ARexx command to be launched. These commands
  292. are usually described in the supplying utilities documentation. Some example
  293. commands and @{"ports" link G_REXP} are:
  294. @{fg highlight}@{u}Port            Command            Action@{uu}@{fg text}
  295. REXX            <Scripname>        Starts an ARexx script
  296. PLAY            file <filename>        Plays a sound sample using Upd
  297. (don't insert < and >)
  298.     This command supports @{"argument substitution" link ARGSUB}.
  299. @endnode
  300. # *****************************************************************************
  301. @node G_REXP "ARexx Port"
  302.     This lets you specify the port or client that the @{"ARexx Command" link REXC} will
  303. be sent to. ARexx ports are CASE SENSITIVE.
  304. @endnode
  305. # *****************************************************************************
  306. @node G_HOTK "Hot Key"
  307.     This string gadget lets you specify a hotkey that will launch this
  308. item. The hotkey is defined in the normal @{"input description" link cx_desc.doc/main} manner. This
  309. feature is only available if you @{"register" link CONTACT} WangiPad.
  310. @endnode
  311. # *****************************************************************************
  312. @node G_TOOL "Tools Menu"
  313.     This checkmark gadget lets you specify if this item is to be added to
  314. the Workbench tools menu.
  315. @endnode
  316. # *****************************************************************************
  317. @node G_ECMD "Edit Command"
  318.     If this checkmark is checked then a requester will popup after you
  319. select this item in the list. It will allow you to change the command that
  320. is to be executed.
  321. @endnode
  322. # *****************************************************************************
  323. @node G_OKBU "Ok"
  324.     Returns to main window, retaining the changes made to this item.
  325. @endnode
  326. # *****************************************************************************
  327. @node G_CANC "Cancel"
  328.     Returns to main window, ignoring changes made to this item.
  329. @endnode
  330. # *****************************************************************************
  331. @node S_FONT "Font"
  332.     Specifies the font to be used in the pad.
  333. @endnode
  334. # *****************************************************************************
  335. @node S_WTIT "Window Title"
  336.     The text on the pad windows titlebar.
  337. @endnode
  338. # *****************************************************************************
  339. @node S_STIT "Screen Title"
  340.     The text on the screen titlebar.
  341. @endnode
  342. # *****************************************************************************
  343. @node S_WIND "Window Settings"
  344.     This item allows you to modify the appearance and positioning of the
  345. pad window. The window that pops up has the following gadgets:
  346.     @{" Left Edge             " link W_LEFT} : Left position of pad.
  347.     @{" Top Edge              " link W_TOPE} : Top position of pad.
  348.     @{" Width                 " link W_WIDT} : Width of pad.
  349.     @{" Height                " link W_HEIG} : Height of pad.
  350.     @{" Grab Current Position " link W_GCPO} : Set the above items.
  351.     @{" PubScreen             " link W_PUBS} : Public Screen.
  352.     @{" ScrollerW             " link W_SCRW} : Scroller Width.
  353.     @{" Pad Type              " link W_PADT} : Type of pad.
  354.     @{" Selection             " link W_SLCT} : Selection of items.
  355.     @{" Ok                    " link W_OKBU} : Accept changes.
  356.     @{" Cancel                " link W_CANC} : Cancel changes.
  357. @endnode
  358. # *****************************************************************************
  359. @node W_LEFT "Left Edge"
  360.     In this integer gadget you can enter the position of the screen that
  361. the left edge of the pad will appear at (in screen pixels).
  362. @endnode
  363. # *****************************************************************************
  364. @node W_TOPE "Top Edge"
  365.     The screen position that the top edge of the pad will appear at, in 
  366. screen pixels
  367. @endnode
  368. # *****************************************************************************
  369. @node W_WIDT "Width"
  370.     Width of the pad, in screen pixels.
  371. @endnode
  372. # *****************************************************************************
  373. @node W_HEIG "Height"
  374.     Height of the pad in screen pixels.
  375. @endnode
  376. # *****************************************************************************
  377. @node W_GCPO "Grab Current Position"
  378.     Sets the the @{"Left Edge" link W_LEFT}, @{"Top Edge" link W_TOPE}, @{"Width" link W_WIDT} and @{"Height" link W_HEIG} gadgets to the 
  379. current values.
  380. @endnode
  381. # *****************************************************************************
  382. @node W_PUBS "Public Screen"
  383.     Specifies the public screen that the pad will open on. Note that
  384. public screen names are case SeNsItIvE :) If blank or the specified
  385. screen does not exist then the pad will open on default public screen.
  386. @endnode
  387. # *****************************************************************************
  388. @node W_SCRW "Scroller Width"
  389.     Lets you alter the width of the scroller in the list in the pad.
  390. @endnode
  391. # *****************************************************************************
  392. @node W_PADT "Pad Type"
  393.     Lets you alter the type of pad created, can one of the following:
  394. @{b}Float@{ub}: The default type of pad, much like any other window.
  395. @{b}Backdrop@{ub}: A backdrop pad. The pad cannot be dragged or depth arranged.
  396. @{b}Backmost@{ub}: As float but the pad is automatically pushed to the back every
  397. @{"n" link n 34} seconds, see @{"bugs" link BASTARDS}.
  398. @{b}FrontMost@{ub}: As Backmost but brought to the front.
  399. @{b}No Border@{ub}: As Backdrop but the pad has no borders... It looks really cool and
  400. appears to be an integral part of your Workbench. My favorite :)
  401. @endnode
  402. # *****************************************************************************
  403. @node W_SLCT "Selection"
  404.     Can be either double-click or single-click. Which ever one is selected
  405. will be used to distinguish a selection on the pad (@{"Registered" link CONTACT} version only)
  406. @endnode
  407. # *****************************************************************************
  408. @node W_OKBU "Ok"
  409.     Accepts the edits made and returns to the main window.
  410. @endnode
  411. # *****************************************************************************
  412. @node W_CANC "Cancels changes made and returns to the main window.
  413. @endnode
  414. # *****************************************************************************
  415. @node UPAD "Using WangiPad"
  416.     @{" Program Arguments             " link P_ARGS} : More Options...
  417.     @{" The Menus, Quitting and Hiding " link P_MENU} : Misc. stuff.
  418.     @{" Error Codes                   " link P_EROR} : Problems?
  419.     For more detailed information on usage, see the chapter on @{"WangiPrefs" link UPREFS}
  420. and the document on @{"argument substitution" link ARGSUB}.
  421. @endnode
  422. # *****************************************************************************
  423. @node P_ARGS "Program Arguments"
  424.     WangiPad supports a number of icon tooltypes, these are useful if
  425. you want to have more than one copy of WangiPad running at a time:
  426. @{b}FROM@{ub}: The preference file that the pad will use. If not specified then
  427. S:Wangi.prefs is used.
  428. @{b}PREF@{ub}: The complete path and file name of the @{"preference editor" link UPREFS}. This is used by
  429. the preferences menuitem. Defaults to SYS:Prefs/WangiPrefs.
  430. @{b}LEVELTIME@{ub}: If the @{"pad type" link G_TYPE} is set to Backmost or Frontmost then every
  431. n seconds it will be pushed/brought to the back/front.
  432. @{b}CX_PRIORITY@{ub}: The priority of WangiPad in the commodities network. Defaults
  433. to -1.
  434. @{b}CX_POPKEY@{ub}: The @{"input description" link cx_desc.doc/main} of the event that will cause the pad 
  435. window to @{"open or close" link P_MENU}. Defaults to "rawkey control w", i.e. Ctrl-w.
  436. These arguments are also supported if WangiPad is launched from the Shell, the
  437. following template is used:
  438.     FROM,PREF/K,LEVELTIME/K/N,CX_PRIORITY/K/N,CX_POPKEY/K
  439. @endnode
  440. # *****************************************************************************
  441. @node P_MENU "The Menus, Quitting and Hiding"
  442.     WangiPad has a menu strip with the following items on it:
  443.     @{" Project/Preferences... " link N_PREF} : Edit preferences.
  444.     @{" Project/About...       " link U_INFO} : Some information.
  445.     @{" Project/Hide           " link N_HIDE} : Hide the pad.
  446.     @{" Project/Quit           " link N_QUIT} : Quit WangiPad.
  447. @endnode
  448. # *****************************************************************************
  449. @node N_PREF "Preferences..."
  450.     Lets you alter the settings of the pad.
  451. @endnode
  452. # *****************************************************************************
  453. @node N_HIDE "Hide"
  454.     Hides the pad. The pad can also be hidden by pressing @{"CX_POPKEY" link P_ARGS}, h,
  455. H or the Hide button in Commodities Exchange. To Show the pad again press
  456. @{"CX_POPKEY" link P_ARGS} or select Show in Commodities Exchange.
  457. @endnode
  458. # *****************************************************************************
  459. @node N_QUIT "Quit"
  460.     Quits WangiPad. Will you ever use this... The Remove button in 
  461. Commodities Exchange, q and Q will also quit WangiPad.
  462. @endnode
  463. # *****************************************************************************
  464. @node P_EROR "Problems, Errors??"
  465.     If an error occurs while WangiPad is initilising then one of the 
  466. following will appear:
  467. 1.    Can't open gadtools.library (or version too old, V36 needed). 
  468. 2.    Can't open graphics.library. 
  469. 3.    Can't open workbench.library (or version too old, V36 needed). 
  470. 4.    Can't open commodities.library (or version too old, V37 needed). 
  471. 5.    Can't open diskfont.library. 
  472. 6.    Can't open icon.library. 
  473. 7.    Unable to load the preference file (most common error). 
  474. 8.    Can't open the window. 
  475. 9.    Can't initilise commodities bits. 
  476. 10.    Can't initilise inter-process-communication bits  
  477. 11.    Can't initilise the AppWindow stuff. 
  478. 12.    Can't initilise DOS Notify stuff. 
  479. 13.    Can't initilise timer bits 'n' bobs.
  480.     If an error occurs when WangiPad is trying to launch a command, i.e.
  481. the command does not exist, then a requester will popup telling you of this.
  482. If any other error occurs or the program fails in any way then please @{"contact" link CONTACT} 
  483. @endnode
  484. # *****************************************************************************
  485. @node ARGSUB "Multiple Argument Substitution"
  486.     WangiPad has a feature that lets you pass arguments to selected 
  487. programs. For example you can create an @{"item" link EDITPAD} to view a picture, but how do
  488. you make it versatile enough to view @{b}any@{ub} file? Simple... argument
  489. substitution. You would, for example, enter the following as the @{"command" link G_CMDX} in
  490. such an item: (Using Viewtek)
  491.     Viewtek []                                           (1)
  492. note the argument braces. You can place these braces anywhere in the command:
  493.     Viewtek [] HIRES LACE                                (2)
  494. To use argument substitution you simple drag the selected icons (you can select
  495. more than one using shift-select or marque) over the corresponding item on the
  496. list or select the item from the Workbench @{"tools menu" link G_TOOL} if it is added to it.
  497. So assuming you dragged a file, file1, on to the above item (2), WangiPad
  498. would expand it to the following before execution:
  499.     Viewtek file1 HIRES LACE                             (3)
  500. If you dragged four files (file1, file2, file3 and file4) then it would be
  501. expanded to:
  502.     Viewtek file1 file2 file3 file4 HIRES LACE           (4)
  503. WangiPad can do this argument expansion to the @{"Command" link G_CMDX} and @{"ARexx Command" link G_REXC}
  504. fields of an item. If an item is of @{"type" link G_TYPE} Workbench then argument substitution
  505. is automatically done as if the files had been shift selected and then the
  506. tool double-clicked, you should (and MUST) not add the [] braces.
  507.     Argument substitution has some problems with Workbench 2.X, see the
  508. section on @{"bugs" link BASTARDS}.
  509. @{i}(In examples (3) and (4) the files are shown simply as fileX in the expanded
  510. command, in reality they also are expanded to their full path, eg 
  511. SYS:Directory/SubDir/file1). Also another limitation of argument substitution
  512. is that the maximum length of command line generated is 255 characters long
  513. (this limitation does not exist in Workbench type items))@{ui}
  514. @endnode
  515. # *****************************************************************************
  516. @node BASTARDS "Bugs"
  517.     A couple of peculiarities (NOT Bugs :) exist in WangiPad, here they 
  518. @{b}Argument Passing@{ub}: The above argument substitution works on any item in the list 
  519. if you are using Workbench 3. However if you are using Workbench 2 then it 
  520. will only work on the first window full of items. No arguments will be passed 
  521. to any items apart from the first pad full. This is due to limitations of 
  522. Workbench 2. You can always access the item from the Workbench tools menu to 
  523. overcome this.
  524. @{b}PadType@{ub}: If you are using MagicMenus then the "Backmost" and "Frontmost" 
  525. options will create a menu time-out every LEVELTIME seconds if the menu is in 
  526. use then. This is not a bug of WangiPad, rather it it a documented side 
  527. effect of MagicMenu, sea the documentation of MagicMenu for more info.
  528. @{b}Workbench launch of programs@{ub}: If you configure a project icon as a "Workbench" 
  529. item then it will only launch successfully if the tooltype of icon is not 
  530. relative, i.e. a tooltype of "IconX" will fail, "C:IconX" will succeed. This 
  531. is a bug with WBStart-Handler.
  532. @endnode
  533. # *****************************************************************************
  534. @node VERH "Version History"
  535.     WangiPad was programmed using Highspeed Pascal on an A1200 with a 
  536. 68030 CPU, 6 MB RAM and 120 MB HD. WangiPad has been tested using Enforcer... 
  537. It has not punched me! (REG) indicates feature is only available if you 
  538. register.
  539. 1.0    : 20.11.94
  540.     + Initial version.
  541. 1.1    : 24.11.94
  542.     + Added "PREF" tooltype and the "About..." and "Preferences..." 
  543.       menuitems to WangiPad.
  544. 1.2    : 04.12.94
  545.     + Added the "Pad Level" MX gadgets, these control if the pad is always
  546.       the front window, backwindow, floating or a backdrop window. Added
  547.       the "LEVELTIME" option to set the time in seconds that it is checked,
  548.       defaulting to 5 seconds.
  549. 1.3    : 11.12.94
  550.     + Added the "Type" cycle gadget to the edit pad item window, commands
  551.       can now be launched as if they were double clicked from Workbench.
  552. 1.4    : 12.12.94
  553.     + Added "ARexx" and "Comment" to the "Type" cycle gadget in the edit pad
  554.       window.
  555.     + When the "Preferences..." menuitem is selected from the pad, the 
  556.       current preference file that the pad is using is edited and not the
  557.       default.
  558. 1.5    : 12.12.94
  559.     + Added "No Border" to the "Pad Level" radio gadgets, with this option
  560.       the pad has no borders, it appears as if the list is directly on and
  561.       part of the Workbench.
  562. 1.6    : 13.12.94
  563.     + Changed the "Pad Level" radio button gadgets to "Pad type" cycle gadget
  564.     + Added "ScrollerW" slider gadget, set the width of the scroller on the
  565.       pad.
  566.     + Changed the "Priority" integer gadget in the edit pad item window to
  567.       a slider gadget.
  568.     + *Huge* cosmetic face lift to the preferences program. How has 
  569.       backfilled areas around the gadgets in all the windows (ala ASL 
  570.       requesters).
  571. 1.7    : 20.12.94
  572.     + Shell commands now inherit their path from WangiPad when WangiPad has 
  573.       been started from the Workbench. (A LOT OF WORK)
  574.     + When an item is "Remove"d from the "List Items" list the list no longer
  575.       moves up to the top item.
  576.     + Escape, "Q" and "q" now quit WangiPad, (when pad window is active).
  577.     + "H" and "h" hides the pad window.
  578. 1.8    : 03.01.95
  579.     + Now uses a key file.
  580.     + Can now use either a single or a double click to select an item in 
  581.       the pad (REG) (suggested by Bill Falls).
  582.     + Items can now have hotkeys (REG) (suggested by Bill Falls).
  583.     + Ctrl-C when pad is active quits.
  584. 1.9    : 04.01.95
  585.     + bugfix, if you picked an invalid font the pad would open with no text,
  586.       now defaults to topaz.
  587.     + default CX_PRIORITY changed from 0 to -1.
  588. 1.10    : 05.01.95
  589.     + Added AppWindow, if you drop an icon on the prefs editor window then a 
  590.       new item matching it will be added to the list.
  591. 1.11    : 11.01.95
  592.     + A requester now pops up if a command can't be executed, the beep
  593.       before was confusing.
  594.     + Code error handling cleaned up.
  595. 1.12    : 15.01.95
  596.     + Removed three Enforcer hits when the close gadget of a "Float" type
  597.       pad was selected (was being closed twice).
  598. 1.13    : 06.02.95
  599.     + Items can now be added to the Tools menu as well.
  600. 1.14    : 25.02.95
  601.     + Added "Append" menuitem to preferences, it will append a preference 
  602.       file to the current one.
  603. 1.15    : 26.02.95
  604.     + Added the "Edit Command" option.
  605. 1.16    : 12.03.95
  606.     + Rewrote documentation. Was 19520 bytes (with 14 nodes, 24 links) now
  607.       37473 bytes (with 71 nodes, 140 links).
  608. @endnode
  609. # *****************************************************************************
  610. @node TODO "My Plans for WangiPad"
  611.     WangiPad is still not complete, here is a list of features that you
  612. should expect to see added to WangiPad (in order of time):
  613.     1. Add "Test" menuitem to preference program.
  614.     2. Allow the specification of minimum and maximum number of 
  615.        arguments if argument substitution is used.
  616.     3. Add an ARexx interface ??????
  617.     4. Reprogram the utility in C.
  618.     5. Add the facility for multiple pads.
  619.     6. Allow images in the list as well as text.
  620.     7. Put the core of the program into a standard Amiga library, so
  621.        that it could be used by external/other programs.
  622.     If you have any other ideas or suggestions then please don not 
  623. hesitate to @{"Contact" link CONTACT} me.
  624. @endnode
  625. # *****************************************************************************
  626. @node TABILLY "Thanks and Greets"
  627. Thanks go to the following people for daily testing and usage:
  628.     Adam Kindness, 
  629.     Tom Pettigrew,
  630.     Jon Pettigrew.
  631. For WBStart-Handler:
  632.     Stefan Becker
  633. For suggestions:
  634.     Tom Pettigrew
  635.     Bill Falls
  636.     Eldr
  637.     SlingShot
  638. And greets to:
  639.     Secka (what is your util then... ?)
  640.     F1Oli (WangiPad is better than ButtonMenu :)
  641.     Eldr (What is the name of your HTML 2 Guide converter then?)
  642.     SlingShot (GuideCompiler is koul...)
  643.     Acechan (I want your mods)
  644.     Logixs
  645.     MagicWB
  646.     Hanz
  647.     Active8
  648.     And to all on #amiga on IRC
  649. @endnode
  650. # *****************************************************************************
  651. @node CONTACT "How to Contact the Author"
  652.     WangiPad is @{b}Shareware@{ub}... A shareware contribution of around @{b}10@{ub} is
  653. expected. If you register WangiPad then you will be sent a @{b}key file@{ub} which
  654. unlocks currently unusable features of WangiPad (i.e. @{b}Hotkeys@{ub}), you will also
  655. be sent a @{b}disk full of programs@{ub} written by myself. If you don't register
  656. WangiPad then the Wangi will get you (I was lying when I said it meant "clean
  657. and fresh"... It is really an evil spirit :)
  658.     Registrations and other correspondence (i.e. @{"bug" link BASTARDS} reports, suggestions,
  659. praise, computers, PD/SW Software, babes....) can be sent to the following
  660. addresses:
  661.     @{" Mail   " link C_MAIL}
  662.     @{" E-Mail " link C_EMAIL}
  663.     @{" IRC    " link C_IRC}
  664. A bit of @{"SIRDS" link SIRDS} fun :)
  665.               X              X              X              X         
  666. HREFITHVZFBGUVDHREFITHVZFBGUVDHREFITHVZFBGUVDHREFITHVZFBGUVDHREFITHVZF
  667. FRTJQMNJOPSJPDFFRTJQMNJOPSJPDFFRTJQMNJOPSJPDFFRTJQMNJOPSJPDFFRTJQMNJOP
  668. LBUNNAFSVWKZDTSLBUNNAFSVWKZDTSBUNNAAFSVWKZDTSBUNNAAFSVWKZDTSBUNNAAFSVW
  669. VZGGUKLOCPHCCFCVZGGUKLOCPHCCFCVGGUKLTOCPHCCFCVGGUKLTOCPHCCFCVGGUKLTOCP
  670. MPCVZKGTDBIAPITMPCKGTDBIAPITMPCKHGTDBAPITMPCKPHGTDBAPITMPCKPHGTDBEAPIT
  671. PUBXLNYCYRNLAPOPULNYCYRNLAPOPULNYVCYRNAPOPULNYDVCYRNAPOPULNYYVCYRNTAPO
  672. ZUUWYTCSPGBEVUTZUUWYTCSPEVUTZKCUUWTCSPEKVUTZKCUUWTCSPEKUTZNKCUWTCSQPEK
  673. VRNBBZWMSYVLERWVRNBBZWMVLERWIGVNBBBWMVLEGRWIGVNBBIWMVLGRWIGVNBBIWLMVLG
  674. WHKXIQQUSLCXVJXWHKXIQQSCXYVOJXHKXICQSCXYVROJXHKICQSSCYVROJXYHKICQSSCYV
  675. JCCSMDZFQWCGVLWJCCSMDFQWCGHVLJCCSMDLFWCGHVKLJCCMDLFFCGHVKLHJCCMDLFFCGH
  676. FZIIUIKDMDJWWYSFZIIUKDMDJFWYSFVZIUKNDDJFWYSOFVZIKNDDJFWYSAOFVZIKNDDJFW
  677. XRGVKEWBQIHQFFJXRGVKWBQIHQFFJMXRGKWBQIHQFFJMMXRGKBQIHQFFNJMMXRGKBQIHQF
  678. LBBYODUJXJDYKOXLBBYODUJXJDYKOXLBBYODUJXJDYKOXLBBYODUJXJDYKOXLBBYODUJXJ
  679. LWUXTQRQRFYRMHYLWUXTQRQRFYRMHYLWUXTQRQRFYRMHYLWUXTQRQRFYRMHYLWUXTQRQRF
  680. Mail me if you can see the image...
  681.     @{fg highlight}@{b}LSK _\\//@{ub}@{fg text}
  682. @endnode
  683. # *****************************************************************************
  684. @node SIRDS "SIRDS"
  685.     This text SIRDS (Single Image Random Dot Stereogram) was created using
  686. make3d (text/misc/mk3d1.1.lha on Aminet). It is highly possible that I will
  687. be programming a utility based on mk3d, so keep a look out for TxtBald (will 
  688. be text/misc/TxtBald.lha on Aminet).
  689. @endnode
  690. # *****************************************************************************
  691. @node C_MAIL "Mail Address"
  692.     Lee Kindness
  693.     8 Craigmarn Road
  694.     Portlethen Village
  695.     Aberdeen
  696.     AB1 4QR
  697.     SCOTLAND.
  698. @endnode
  699. # *****************************************************************************
  700. @node C_EMAIL "email address"
  701. Up until around September 95:
  702.     bh1bs@rgueee.eee.rgu.ac.uk   (put "LSK" in the subject)
  703. After around September 95:
  704.     @{fg highlight}cs1lk@sal.scms.rgu.ac.uk@{fg text}  @{b}(PLEASE ALWAYS TRY THIS FIRST EVEN BEFORE@{ub}
  705.     or                         @{b}SEPTEMBER 95)@{ub}
  706.     cs2lk@sal.scms.rgu.ac.uk
  707. @endnode
  708. # *****************************************************************************
  709. @node C_IRC "Internet Relay Chat"
  710.     You can catch me on IRC quite regularly (maybe 1-2pm GMT week days
  711. and other misc. times). My nick is @{b}Wangi@{ub} (normally on #amiga and #theend, 
  712. so please type:
  713.     /describe gives Wangi a pad          (or similar...)
  714. while on #amiga. If I'm not there then you can always leave a message with 
  715. the bot mama.
  716. @endnode
  717. IF YOU ARE READING THIS THEN YOU MUST BE INQUISITIVE (OR VIEWING THIS FILE
  718. THROUGH A TEXT VIEWER)... L85 D00D!!
  719.